parse-author

What is parse-author?

The parse-author npm package is a utility for parsing author strings in package.json files. It helps in extracting structured information such as name, email, and URL from a single author string.

What are parse-author's main functionalities?

Parse Author String

This feature allows you to parse a single author string into an object containing the name, email, and URL. The code sample demonstrates how to use the parse-author package to parse an author string and log the resulting object.

const parseAuthor = require('parse-author');
const author = 'John Doe <[e-mail]> (http://johndoe.com)';
const parsed = parseAuthor(author);
console.log(parsed);

Other packages similar to parse-author

author-regex

The author-regex package uses regular expressions to parse author strings. While it provides similar parsing capabilities, it is more focused on the regex approach and might require additional handling to achieve the same level of convenience as parse-author.

README

parse-author

Parse a string into an object with name, email and url properties following npm conventions. Useful for the authors property in package.json or for parsing an AUTHORS file into an array of authors objects.

Install

Install with npm:

$ npm install parse-author --save

Usage

var authors = require('parse-author');

authors('Jon Schlinkert <[e-mail]> (https://github.com/jonschlinkert)');
//=> {name: 'Jon Schlinkert', email: '[e-mail]', url: 'https://github.com/jonschlinkert'}

Any of the properties can be used or missing:

authors('')
//=> {name: '', email: '', url: ''}

authors('Jon Schlinkert (https://github.com/jonschlinkert)');
//=> {name: 'Jon Schlinkert', email: '', url: 'https://github.com/jonschlinkert'}

Related projects

You might also be interested in these projects:

• author-regex: Regular expression for parsing an author string into an object following npm conventions. | homepage
• parse-authors: Parse a string into an array of objects with name, email and url properties following… more | homepage
• stringify-author: Stringify an authors object to name <email> (url). | homepage
• stringify-authors: Converts an author object or array of author objects into an array of strings. Useful… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

---

This file was generated by verb, v0.9.0, on April 13, 2016.